Layer Definition Schema
LISTBOX Element
See Also  Send comments on this topic.
Layer Definition Schema : LISTBOX Element

Glossary Item Box

Description

Used to define a ListBox control in a form.

Diagram

LISTITEM Element Sequence LISTBOX Element

Overview

LISTBOX
Used to define a ListBox control in a form.
height required xs:int
The height of the list box.
width required xs:int
The width of the list box.
x required xs:int
The x coordinate of the upper left corner of the list box.
y required xs:int
The y coordinate of the upper left corner of the list box
backgroundcolor optional
The background color to use for the list box. If not specified, this value is inherited from the page's backgroundcolor attribute.
border optional Restriction of xs:string
Specifies whether the list box has a border.
color optional
The color to use for the list box's text. If not specified, this value is inherited from the page's color attribute.
defaultvalue optional xs:string
A simple expression that specifies the default value of the combo box.
field optional xs:string
The field of the shapefile's DBF table that is linked to the list box.
font optional
The font to use for the list box's text. If not specified, this value is inherited from the page's font attribute.
fontsize optional Restriction of xs:int
The font size to use for the list box's text. If not specified, this value is inherited from the page's fontsize attribute.
fontstyle optional Restriction of xs:string
The font style to use for the list box's text. If not specified, this value is inherited from the page's fontstyle attribute. If the value is not regular, it can be any combination of other values, expressed as a comma delimited list (for example, fontstyle="bold,underline").
group optional Restriction of xs:string
Specifies whether the list box starts a new group of controls.
hscroll optional Restriction of xs:string
Specifies if the list box should have a horizontal scroll bar
listtable optional xs:string
The DBF table used to populate the list box.
listtextfield optional xs:string
The field of the DBF table that contains the data used to populate the text component of the list box's items.
listvaluefield optional xs:string
The field of the DBF table that contains the data used to populate the value component of the list box's items.
name optional xs:string
Name of the ListBox control. Used to reference the control in scripts.
onkillfocus optional
Specify the script to run when this event occurs.
onselcancel optional
Specify the script to run when this event occurs.
onselchange optional
Specify the script to run when this event occurs.
onsetfocus optional
Specify the script to run when this event occurs.
onvalidate optional
Specify the script to run when this event occurs.
readonly optional Restriction of xs:string
Specifies whether the list box's value can be modified by the user.
required optional Restriction of xs:string
Specifies if the user must enter some text in the list box.
showvalues optional Restriction of xs:string
Specifies if the values are displayed next to the text for items in the list box.
sort optional Restriction of xs:string
Specifies if the items in the list box are automatically sorted alphabetically.
tabstop optional Restriction of xs:string
Specifies if the items in the list box are automatically sorted alphabetically.
vscroll optional Restriction of xs:string
Specifies if the list box should have a vertical scroll bar
Sequence
LISTITEM 1..∞
Used to define an item in a ComboBox or ListBox form control.

Attributes

NameTypeUseDefaultFixedDescription
heightxs:intrequired  The height of the list box.
widthxs:intrequired  The width of the list box.
xxs:intrequired  The x coordinate of the upper left corner of the list box.
yxs:intrequired  The y coordinate of the upper left corner of the list box
backgroundcolor optional  The background color to use for the list box. If not specified, this value is inherited from the page's backgroundcolor attribute.
borderRestriction of xs:stringoptional  Specifies whether the list box has a border.
color optional  The color to use for the list box's text. If not specified, this value is inherited from the page's color attribute.
defaultvaluexs:stringoptional  A simple expression that specifies the default value of the combo box.
fieldxs:stringoptional  The field of the shapefile's DBF table that is linked to the list box.
font optional  The font to use for the list box's text. If not specified, this value is inherited from the page's font attribute.
fontsizeRestriction of xs:intoptional  The font size to use for the list box's text. If not specified, this value is inherited from the page's fontsize attribute.
fontstyleRestriction of xs:stringoptionalregular The font style to use for the list box's text. If not specified, this value is inherited from the page's fontstyle attribute. If the value is not regular, it can be any combination of other values, expressed as a comma delimited list (for example, fontstyle="bold,underline").
groupRestriction of xs:stringoptionalfalse Specifies whether the list box starts a new group of controls.
hscrollRestriction of xs:stringoptional  Specifies if the list box should have a horizontal scroll bar
listtablexs:stringoptional  The DBF table used to populate the list box.
listtextfieldxs:stringoptional  The field of the DBF table that contains the data used to populate the text component of the list box's items.
listvaluefieldxs:stringoptional  The field of the DBF table that contains the data used to populate the value component of the list box's items.
namexs:stringoptional  Name of the ListBox control. Used to reference the control in scripts.
onkillfocus optional  Specify the script to run when this event occurs.
onselcancel optional  Specify the script to run when this event occurs.
onselchange optional  Specify the script to run when this event occurs.
onsetfocus optional  Specify the script to run when this event occurs.
onvalidate optional  Specify the script to run when this event occurs.
readonlyRestriction of xs:stringoptionalfalse Specifies whether the list box's value can be modified by the user.
requiredRestriction of xs:stringoptionalfalse Specifies if the user must enter some text in the list box.
showvaluesRestriction of xs:stringoptionaltrue Specifies if the values are displayed next to the text for items in the list box.
sortRestriction of xs:stringoptionaltrue Specifies if the items in the list box are automatically sorted alphabetically.
tabstopRestriction of xs:stringoptionaltrue Specifies if the items in the list box are automatically sorted alphabetically.
vscrollRestriction of xs:stringoptionalfalse Specifies if the list box should have a vertical scroll bar

Examples

Restrictions

The following attributes can only be used in edit and identify forms. They cannot be used in general forms:; field; required

Source

<xs:element name="LISTBOX" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:documentation>Used to define a ListBox control in a form.</xs:documentation>
  </xs:annotation>
  <xs:complexType>
    <xs:sequence>
      <xs:element maxOccurs="unbounded" ref="LISTITEM">
        <xs:annotation>
          <xs:documentation>Used to define an item in a ComboBox or ListBox form control.</xs:documentation>
        </xs:annotation>
      </xs:element>
    </xs:sequence>
    <xs:attribute use="required" name="height" type="xs:int">
      <xs:annotation>
        <xs:documentation>The height of the list box.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute use="required" name="width" type="xs:int">
      <xs:annotation>
        <xs:documentation>The width of the list box.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="x" type="xs:int" use="required">
      <xs:annotation>
        <xs:documentation>The x coordinate of the upper left corner of the list box.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="y" type="xs:int" use="required">
      <xs:annotation>
        <xs:documentation>The y coordinate of the upper left corner of the list box</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="backgroundcolor">
      <xs:annotation>
        <xs:documentation>The background color to use for the list box. If not specified, this value is inherited from the page's backgroundcolor attribute.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="border">
      <xs:annotation>
        <xs:documentation>Specifies whether the list box has a border.</xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:enumeration value="true" />
          <xs:enumeration value="false" />
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
    <xs:attribute name="color">
      <xs:annotation>
        <xs:documentation>The color to use for the list box's text. If not specified, this value is inherited from the page's color attribute.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="defaultvalue" type="xs:string">
      <xs:annotation>
        <xs:documentation>A simple expression that specifies the default value of the combo box.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="field" type="xs:string">
      <xs:annotation>
        <xs:documentation>The field of the shapefile's DBF table that is linked to the list box.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="font">
      <xs:annotation>
        <xs:documentation>The font to use for the list box's text. If not specified, this value is inherited from the page's font attribute.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="fontsize">
      <xs:annotation>
        <xs:documentation>The font size to use for the list box's text. If not specified, this value is inherited from the page's fontsize attribute.</xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:int">
          <xs:minInclusive value="1" />
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
    <xs:attribute default="regular" name="fontstyle">
      <xs:annotation>
        <xs:documentation>The font style to use for the list box's text. If not specified, this value is inherited from the page's fontstyle attribute. If the value is not regular, it can be any combination of other values, expressed as a comma delimited list (for example, fontstyle="bold,underline").</xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:enumeration value="regular" />
          <xs:enumeration value="bold" />
          <xs:enumeration value="italic" />
          <xs:enumeration value="underline" />
          <xs:enumeration value="strikeout" />
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
    <xs:attribute default="false" name="group">
      <xs:annotation>
        <xs:documentation>Specifies whether the list box starts a new group of controls.</xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:enumeration value="true" />
          <xs:enumeration value="false" />
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
    <xs:attribute name="hscroll">
      <xs:annotation>
        <xs:documentation>Specifies if the list box should have a horizontal scroll bar</xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:enumeration value="true" />
          <xs:enumeration value="false" />
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
    <xs:attribute name="listtable" type="xs:string">
      <xs:annotation>
        <xs:documentation>The DBF table used to populate the list box.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="listtextfield" type="xs:string">
      <xs:annotation>
        <xs:documentation>The field of the DBF table that contains the data used to populate the text component of the list box's items.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="listvaluefield" type="xs:string">
      <xs:annotation>
        <xs:documentation>The field of the DBF table that contains the data used to populate the value component of the list box's items.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="name" type="xs:string">
      <xs:annotation>
        <xs:documentation>Name of the ListBox control. Used to reference the control in scripts.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="onkillfocus">
      <xs:annotation>
        <xs:documentation>Specify the script to run when this event occurs.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="onselcancel">
      <xs:annotation>
        <xs:documentation>Specify the script to run when this event occurs.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="onselchange">
      <xs:annotation>
        <xs:documentation>Specify the script to run when this event occurs.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="onsetfocus">
      <xs:annotation>
        <xs:documentation>Specify the script to run when this event occurs.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="onvalidate">
      <xs:annotation>
        <xs:documentation>Specify the script to run when this event occurs.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="readonly" default="false">
      <xs:annotation>
        <xs:documentation>Specifies whether the list box's value can be modified by the user.</xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:enumeration value="true" />
          <xs:enumeration value="false" />
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
    <xs:attribute name="required" default="false">
      <xs:annotation>
        <xs:documentation>Specifies if the user must enter some text in the list box.</xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:enumeration value="true" />
          <xs:enumeration value="false" />
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
    <xs:attribute name="showvalues" default="true">
      <xs:annotation>
        <xs:documentation>Specifies if the values are displayed next to the text for items in the list box.</xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:enumeration value="true" />
          <xs:enumeration value="false" />
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
    <xs:attribute name="sort" default="true">
      <xs:annotation>
        <xs:documentation>Specifies if the items in the list box are automatically sorted alphabetically.</xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:enumeration value="true" />
          <xs:enumeration value="false" />
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
    <xs:attribute name="tabstop" default="true">
      <xs:annotation>
        <xs:documentation>Specifies if the items in the list box are automatically sorted alphabetically.</xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:enumeration value="true" />
          <xs:enumeration value="false" />
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
    <xs:attribute name="vscroll" default="false">
      <xs:annotation>
        <xs:documentation>Specifies if the list box should have a vertical scroll bar</xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:enumeration value="true" />
          <xs:enumeration value="false" />
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
  </xs:complexType>
</xs:element>

See Also

© 2013 All Rights Reserved.